Add task to collect proto files and add steps to release them with tester, nightly and stable builds #1931
Conversation
|
Tester build with proto files: https://github.com/arduino/arduino-cli/actions/runs/3282804966
|
cmaglie
added
type: enhancement
| # Run this after checksums or the uploaded proto files zip | ||
| # will make the checksum job always fail | ||
| needs: | ||
| - checksums | ||
| - package-name-prefix |
There was a problem hiding this comment.
Why checksums is failing? shouldn't just add the checksum of the protoc archive to the checksums file together with the other archives?
There was a problem hiding this comment.
I didn't think about that, it would make sense since it's a file part of the release. 🤔
I'd have to edit a bit the checksum process I think, I'll take a look at it.
| proto-files: | ||
| needs: | ||
| - package-name-prefix | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Task | ||
| uses: arduino/setup-task@v1 | ||
| with: | ||
| repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
| version: 3.x | ||
|
|
||
| - name: Collect proto files | ||
| run: | | ||
| PACKAGE_NAME_PREFIX=${{ needs.package-name-prefix.outputs.prefix }} | ||
| export PACKAGE_NAME_PREFIX | ||
| task protoc:collect | ||
|
|
||
| - name: Upload proto files zip | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| path: ${{ env.DIST_DIR }}/*.zip | ||
| name: rpc-protocol-files | ||
|
|
There was a problem hiding this comment.
what do you think about adding this as an additional step in the matrix of build job? It seems like almost all the steps are the same, we could avoid some code duplication.
There was a problem hiding this comment.
I don't think it's semantically correct, this job doesn't build anything in itself.
It also would require some changes to that job to make it more generic if we want to go toward that direction too.
There was a problem hiding this comment.
I wouldn't duplicate the code that way. There are some things that could be made in order to achieve that:
- If we move the task
protoc:collecttoDistTask.ymlthe workflow do not require any big change. - another idea would be to simply rename the task as
dist:protoc-collect - or maybe just move
dist:in thematrix.os.task
There was a problem hiding this comment.
Wasn't DistTask.ymlshared in other projects too? I thought of putting it there but didn't cause of that.
Second and third might work but we'd still need to reword the build job and os matrix variable to be generic.
There was a problem hiding this comment.
mhh yes, the DistTask.yaml is shared and probably better to not touch it... Second and third seems more approachable to me with the proper rewording
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Adds a new task and changes the tester, nightly and stable build release processes.
What is the current behavior?
Currently there is no easy way for developers to download only
.protofiles to work on projects that depend on them.Those files are necessary to generate other languages files to handle gRPC communication.
The only way as of now is to download the whole
arduino-clirepo and copy the files.What is the new behavior?
A new command has been added to zip all the
.protofiles and save them indist, the task is calledprotoc:collect.The output zip will be called
arduino-cli_<version>_proto.zip,<version>as defined here. The command can be run locally and on CI.This zip will also be included in the released files for tester, nightly and stable builds.
Does this PR introduce a breaking change, and is titled accordingly?
None.
Other information
Closes #588.